Skip to content

chore: address commit comments (#5894) #5978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Apr 3, 2025
Merged

chore: address commit comments (#5894) #5978

merged 5 commits into from
Apr 3, 2025

Conversation

JaySoni1
Copy link
Contributor

@JaySoni1 JaySoni1 commented Mar 11, 2025 •
edited
Loading

Description

This PR addresses the feedback provided on commit c31eccd, specifically the review comment regarding the JSDoc typedef for ComplexArray.

Changes Made

  • Reverted the incorrect modification to the JSDoc type annotation on Line 103.
  • Restored ComplexArray as a defined JSDoc type, per the suggestion.
  • Confirmed that the linting error was a false positive and no further change was required.

Files Updated

  • stdlib/lib/node_modules/@stdlib/array/filled/lib/main.js

Context

The review comment referenced:

Line 103: This change should be reverted. ComplexArray is a defined JSDoc type.
See stdlib/tools/docs/jsdoc/typedefs/arrays.js.

✅ Verified that ComplexArray is properly defined in typedefs/arrays.js, and the JSDoc usage is now consistent with project standards.

Related Issue

Closes #5894

Checklist

  • Read, understood, and followed the contributing guidelines
  • Followed the contributing guidelines
  • Made changes in a separate branch from develop
  • Passed all existing tests
  • Verified linting and formatting compliance

@JaySoni1
Reverted ComplexArray
f440e89 
Signed-off-by: JaySoni1 <[email protected]>
@stdlib-bot stdlib-bot added First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Mar 11, 2025
@stdlib-bot
Copy link
Contributor

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

  1. Please read our contributing guidelines.

  2. Update your pull request description to include this checked box:

    - [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

  • The developer's certificate of origin
  • Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

stdlib-bot
stdlib-bot reviewed Mar 11, 2025
View reviewed changes
Copy link
Contributor

@stdlib-bot stdlib-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

@stdlib-bot
Copy link
Contributor

stdlib-bot commented Mar 11, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
array/filled $\color{green}418/418$
$\color{green}+100.00\%$ 		$\color{green}68/68$
$\color{green}+100.00\%$ 		$\color{green}3/3$
$\color{green}+100.00\%$ 		$\color{green}418/418$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

@stdlib-bot stdlib-bot removed the First-time Contributor A pull request from a contributor who has never previously committed to the project repository. label Mar 17, 2025
@JaySoni1 JaySoni1 requested a review from stdlib-bot March 19, 2025 10:01
@JaySoni1
Copy link
Contributor Author

@Planeshifter , @kgryte please review

@kgryte kgryte changed the title 🔧 Address commit comments on commit c31eccd (#5894) chore: address commit comments (#5894) Apr 2, 2025
kgryte
kgryte previously approved these changes Apr 2, 2025
View reviewed changes
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Apr 2, 2025
@kgryte
style: disable lint rule
29e01cd 
This commit disables a lint rule due to a false positive arising from `ComplexArray`. This is a defined type currently in our JSDoc type definitions.

Signed-off-by: Athan <[email protected]>
kgryte
kgryte previously approved these changes Apr 2, 2025
View reviewed changes
@kgryte
Copy link
Member

kgryte commented Apr 3, 2025

/stdlib merge

@stdlib-bot stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Apr 3, 2025
@stdlib-bot stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Apr 3, 2025
@kgryte kgryte merged commit 54534dd into stdlib-js:develop Apr 3, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kgryte kgryte kgryte left review comments

@stdlib-bot stdlib-bot Awaiting requested review from stdlib-bot

Assignees
No one assigned
Labels
Documentation Improvements, additions, or changes to documentation. Good First PR A pull request resolving a Good First Issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Address commit comments (commit c31eccd)
3 participants
@JaySoni1 @stdlib-bot @kgryte